Platform Explorer / Nuxeo Platform 2023.15

Operation Document.GetRendition (Gets a document rendition)

In component org.nuxeo.ecm.platform.rendition.operations

Description

Gets a document rendition given its name. Returns the rendition blob.
Operation id Document.GetRendition
Category Files
Label Gets a document rendition
Requires
Since

Parameters

Name Description Type Required Default value
renditionName string yes  

Signature

Inputs document, documents
Outputs blob, bloblist

Implementation Information

Implementation Class Class: org.nuxeo.ecm.platform.rendition.operation.GetRendition
Contributing Component org.nuxeo.ecm.platform.rendition.operations

JSON Definition

{
  "id" : "Document.GetRendition",
  "label" : "Gets a document rendition",
  "category" : "Files",
  "requires" : null,
  "description" : "Gets a document rendition given its name. Returns the rendition blob.",
  "url" : "Document.GetRendition",
  "signature" : [ "document", "blob", "documents", "bloblist" ],
  "params" : [ {
    "name" : "renditionName",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}